package com.black.cat.environment;

import com.black.cat.lang.Nullable;

/**
 *
 *  属性解析器接口定义
 *  主要有两大功能
 *  1、通过propertyName属性名获取与之对应的propertValue属性值（getProperty）。
 *  2、把${propertyName:defaultValue}格式的属性占位符，替换为实际的值(resolvePlaceholders)
 *
 *
 *
 */
public interface PropertyResolver {

    // 查看规定指定的key是否有对应的value   注意：若对应值是null的话 也是返回false
    boolean containsProperty(String key);

    // 如果没有则返回null
    @Nullable
    String getProperty(String key);

    /**
     *  获取给定key的值，如果无法解析返回defaultValue
     * @param key
     * @param defaultValue
     * @return
     */
    String getProperty(String key, String defaultValue);


    // 返回指定key对应的value，会解析成指定类型。如果没有对应值则返回null（而不是抛错~）
    @Nullable
    <T> T getProperty(String key, Class<T> targetType);


    <T> T getProperty(String key, Class<T> targetType, T defaultValue);

    // 若不存在就不是返回null了  而是抛出异常~  所以不用担心返回值是null
    String getRequiredProperty(String key) throws IllegalStateException;


    <T> T getRequiredProperty(String key, Class<T> targetType) throws IllegalStateException;

    // 解析${...}这种类型的占位符，把他们替换为使用getProperty方法返回的结果，解析不了并且没有默认值的占位符会被忽略（原样输出）
    String resolvePlaceholders(String text);


    String resolveRequiredPlaceholders(String text) throws IllegalArgumentException;


}
